home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / chbevd.z / chbevd
Encoding:
Text File  |  2002-10-03  |  7.5 KB  |  199 lines
  1.  
  2.  
  3.  
  4. CCCCHHHHBBBBEEEEVVVVDDDD((((3333SSSS))))                                                          CCCCHHHHBBBBEEEEVVVVDDDD((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CHBEVD - compute all the eigenvalues and, optionally, eigenvectors of a
  10.      complex Hermitian band matrix A
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CHBEVD( JOBZ, UPLO, N, KD, AB, LDAB, W, Z, LDZ, WORK, LWORK,
  14.                         RWORK, LRWORK, IWORK, LIWORK, INFO )
  15.  
  16.          CHARACTER      JOBZ, UPLO
  17.  
  18.          INTEGER        INFO, KD, LDAB, LDZ, LIWORK, LRWORK, LWORK, N
  19.  
  20.          INTEGER        IWORK( * )
  21.  
  22.          REAL           RWORK( * ), W( * )
  23.  
  24.          COMPLEX        AB( LDAB, * ), WORK( * ), Z( LDZ, * )
  25.  
  26. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  27.      These routines are part of the SCSL Scientific Library and can be loaded
  28.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  29.      directs the linker to use the multi-processor version of the library.
  30.  
  31.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  32.      4 bytes (32 bits). Another version of SCSL is available in which integers
  33.      are 8 bytes (64 bits).  This version allows the user access to larger
  34.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  35.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  36.      only one of the two versions; 4-byte integer and 8-byte integer library
  37.      calls cannot be mixed.
  38.  
  39. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  40.      CHBEVD computes all the eigenvalues and, optionally, eigenvectors of a
  41.      complex Hermitian band matrix A. If eigenvectors are desired, it uses a
  42.      divide and conquer algorithm.
  43.  
  44.      The divide and conquer algorithm makes very mild assumptions about
  45.      floating point arithmetic. It will work on machines with a guard digit in
  46.      add/subtract, or on those binary machines without guard digits which
  47.      subtract like the Cray X-MP, Cray Y-MP, Cray C-90, or Cray-2. It could
  48.      conceivably fail on hexadecimal or decimal machines without guard digits,
  49.      but we know of none.
  50.  
  51.  
  52. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  53.      JOBZ    (input) CHARACTER*1
  54.              = 'N':  Compute eigenvalues only;
  55.              = 'V':  Compute eigenvalues and eigenvectors.
  56.  
  57.      UPLO    (input) CHARACTER*1
  58.              = 'U':  Upper triangle of A is stored;
  59.              = 'L':  Lower triangle of A is stored.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCHHHHBBBBEEEEVVVVDDDD((((3333SSSS))))                                                          CCCCHHHHBBBBEEEEVVVVDDDD((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      N       (input) INTEGER
  75.              The order of the matrix A.  N >= 0.
  76.  
  77.      KD      (input) INTEGER
  78.              The number of superdiagonals of the matrix A if UPLO = 'U', or
  79.              the number of subdiagonals if UPLO = 'L'.  KD >= 0.
  80.  
  81.      AB      (input/output) COMPLEX array, dimension (LDAB, N)
  82.              On entry, the upper or lower triangle of the Hermitian band
  83.              matrix A, stored in the first KD+1 rows of the array.  The j-th
  84.              column of A is stored in the j-th column of the array AB as
  85.              follows:  if UPLO = 'U', AB(kd+1+i-j,j) = A(i,j) for max(1,j-
  86.              kd)<=i<=j; if UPLO = 'L', AB(1+i-j,j)    = A(i,j) for
  87.              j<=i<=min(n,j+kd).
  88.  
  89.              On exit, AB is overwritten by values generated during the
  90.              reduction to tridiagonal form.  If UPLO = 'U', the first
  91.              superdiagonal and the diagonal of the tridiagonal matrix T are
  92.              returned in rows KD and KD+1 of AB, and if UPLO = 'L', the
  93.              diagonal and first subdiagonal of T are returned in the first two
  94.              rows of AB.
  95.  
  96.      LDAB    (input) INTEGER
  97.              The leading dimension of the array AB.  LDAB >= KD + 1.
  98.  
  99.      W       (output) REAL array, dimension (N)
  100.              If INFO = 0, the eigenvalues in ascending order.
  101.  
  102.      Z       (output) COMPLEX array, dimension (LDZ, N)
  103.              If JOBZ = 'V', then if INFO = 0, Z contains the orthonormal
  104.              eigenvectors of the matrix A, with the i-th column of Z holding
  105.              the eigenvector associated with W(i).  If JOBZ = 'N', then Z is
  106.              not referenced.
  107.  
  108.      LDZ     (input) INTEGER
  109.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  110.              'V', LDZ >= max(1,N).
  111.  
  112.      WORK    (workspace/output) COMPLEX array, dimension (LWORK)
  113.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  114.  
  115.      LWORK   (input) INTEGER
  116.              The dimension of the array WORK.  If N <= 1,               LWORK
  117.              must be at least 1.  If JOBZ = 'N' and N > 1, LWORK must be at
  118.              least N.  If JOBZ = 'V' and N > 1, LWORK must be at least 2*N**2.
  119.  
  120.              If LWORK = -1, then a workspace query is assumed; the routine
  121.              only calculates the optimal size of the WORK array, returns this
  122.              value as the first entry of the WORK array, and no error message
  123.              related to LWORK is issued by XERBLA.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCHHHHBBBBEEEEVVVVDDDD((((3333SSSS))))                                                          CCCCHHHHBBBBEEEEVVVVDDDD((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      RWORK   (workspace/output) REAL array,
  141.              dimension (LRWORK) On exit, if INFO = 0, RWORK(1) returns the
  142.              optimal LRWORK.
  143.  
  144.      LRWORK  (input) INTEGER
  145.              The dimension of array RWORK.  If N <= 1,               LRWORK
  146.              must be at least 1.  If JOBZ = 'N' and N > 1, LRWORK must be at
  147.              least N.  If JOBZ = 'V' and N > 1, LRWORK must be at least 1 +
  148.              5*N + 2*N**2.
  149.  
  150.              If LRWORK = -1, then a workspace query is assumed; the routine
  151.              only calculates the optimal size of the RWORK array, returns this
  152.              value as the first entry of the RWORK array, and no error message
  153.              related to LRWORK is issued by XERBLA.
  154.  
  155.      IWORK   (workspace/output) INTEGER array, dimension (LIWORK)
  156.              On exit, if INFO = 0, IWORK(1) returns the optimal LIWORK.
  157.  
  158.      LIWORK  (input) INTEGER
  159.              The dimension of array IWORK.  If JOBZ = 'N' or N <= 1, LIWORK
  160.              must be at least 1.  If JOBZ = 'V' and N > 1, LIWORK must be at
  161.              least 3 + 5*N .
  162.  
  163.              If LIWORK = -1, then a workspace query is assumed; the routine
  164.              only calculates the optimal size of the IWORK array, returns this
  165.              value as the first entry of the IWORK array, and no error message
  166.              related to LIWORK is issued by XERBLA.
  167.  
  168.      INFO    (output) INTEGER
  169.              = 0:  successful exit.
  170.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  171.              > 0:  if INFO = i, the algorithm failed to converge; i off-
  172.              diagonal elements of an intermediate tridiagonal form did not
  173.              converge to zero.
  174.  
  175. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  176.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  177.  
  178.      This man page is available only online.
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.